mypy - FSM by miruuna · Pull Request #940 · DUNE-DAQ/drunc

miruuna · 2026-06-09T18:55:53Z

Description

Fixes issue #846

Added type hints tosrc/drunc/fsm/. All Protocols are found in fsm/_protocols.py.

The relevant changes in the user workflow have been documented here (link URL)

Type of change

List of required branches from other repositories

None

Change log

Made fsm mypy compliant.

Suggested manual testing checklist

mypy src/drunc/fsm --follow-imports=silent - silent is needed as the other imports are not mypy compliant yet
pytest src/drunc/fsm

Prior to marking this as "Ready for Review"

Tests ran on: local device

Unit tests - some tests can't be ran on the CI. This is documented. If this PR checks a feature that can't be tested with CI, this has been marked appropriately.

Integration tests - the daqsystemtest_integtest_bundle requires a lot of resources, and connections to the EHN1 infrastructure. Check the cross referenced list if you can't run these. The developer needs to run at least the .

Unit tests (pytest --marker) passed
- With relevant marker
- Without marker
Integration tests passed
- Only daqsystemtest_integtest_bundle.sh -k minimal_system_quick_test.py
- Full daqsystemtest_integtest_bundle.sh
Testing skipped as there are no core code changes in this PR, this only relates to documentation/CI workflows
Drunc integration tests pass (./scripts/drunc_integtest_bundle.sh)

Final checklist prior to marking this as "Ready for Review"

Code is clearly commented.
New unit tests have been added, or is documented in # ISSUE NUMBER
A suitable reviewer has been chosen from this list.

Reviewer checklist

This branch has been rebased with develop prior to testing.
Suggested manual tests show changes.
CI workflows fails documented (if present)
Integration tests passed (on either np0x or IC HEP clusters)
- Use the following guidelines to determine which of the integration tests you need to run
  - You do not need to run any integration tests if
    - Code changes are not associated with src/
    - PR changes only affect docstrings
    - In this case, be sure to validate any suggested manual testing.
  - Run only the minimum integration test as daqsystemtest_integtest_bundle.sh -k minimal_system_quick_test.py if
    - PR changes only affect a few log entries
    - PR changes are small, and do not have a large impact on the workflow (use carefully)
  - Otherwise run the full integration test bundle as daqsystemtest_integtest_bundle.sh
- What to do if the integration tests fail?
  - Only concern yourself if failures related to drunc are in the log files
  - If non-drunc failure appears:
    - Validate failure in fresh working area
    - Contact Pawel if unsure
If you have ran the full integration test bundle, leave a comment on the PR stating
- Which host the integration tests have ran on
- [Optional] A copy of the test summary
Drunc integration tests pass (scripts/drunc_integtest_bundle.sh)

Once the above boxes are checked, the PR(s) can be merged following the steps below.

Prior to merging

Choose one of the following an complete all substeps

Changes only affect the Run Control, are in a single repository, and do not affect the end user.
- Changes are documented in docstrings and code comments
- Wiki has been updated if architectural or endpoint changes
Otherwise
- Workflow changes demonstrated in the Change Log (if necessary)
- Wiki has been updated (if necessary)
- #dunedaq-integration Slack channel notified (see below)

Once completed, the reviewer can merge the PR.

Notification message for a Slack channel

Note - this should be to #dunedaq-integration for general workflow that isn't during a release candidate period, and to #daq-release-prep otherwise.

For an single merge that changes the user workflow

The CCM WG has an isolated PR ready to merge that affects user workflows. The PR is:

_URL_

I will leave time for any comments, otherwise will merge these at the end of the work day _Insert your time zone_.

For co-ordinated merge

The CCM WG has a set of co-ordinated merges ready to merge. The PRs are:

_URL_

_URL_


I will leave time for any comments, otherwise will merge these at the end of the day.

miruuna · 2026-06-18T11:51:13Z

Used pybind11-stubgen to automatically generate the stubs for conffwk. To generate (or regenerate) the stubs int he /typings/ directory, run:
pybind11-stubgen conffwk --output-dir=typings
This would only have to be done if conffwk changes.

However, after running that we get:

pybind11_stubgen - [  ERROR] In conffwk._daq_conffwk_py._Configuration.destroy_obj : Invalid expression 'dunedaq::conffwk::ConfigObject'
pybind11_stubgen - [  ERROR] In conffwk._daq_conffwk_py._Configuration.get_obj : Invalid expression 'dunedaq::conffwk::ConfigObject'
pybind11_stubgen - [  ERROR] In conffwk._daq_conffwk_py._Configuration.get_objs : Invalid expression 'dunedaq::conffwk::ConfigObject'
pybind11_stubgen - [WARNING] Raw C++ types/values were found in signatures extracted from docstrings.

That probably means that the pybind11 wrapper for conffwk might have missed some bits or didn't link the return types correctly.

In the case of the conffwk's dal submodule used in /fsm/, a couple of the stubbed methods returned Any so they need to be added manually. That is done in the clean_stubs.py script, which again, should be run only if changes to conffwk were added, or the stubs need changing.

The stubs for daqconf were added manually.

jamesturner246 · 2026-06-30T16:00:25Z

I've looked into this, and the issue with the faulty bindings type generation lies in the binding source in the conffwk repository. Luckily it's an easy fix, but will require synchronisation with the maintainers as we need to set up some CI to automate type binding generation.

@PawelPlesniak, @miruuna, let's discuss this on Thursday.

PawelPlesniak · 2026-07-08T11:29:29Z

Conversation regarding the required changes in conffwk and the idea of CI workflows regarding stub generation have been started on Slack between @jcfreeman2, @jamesturner246, and mysefl

PawelPlesniak · 2026-07-16T16:30:53Z

Thank you @miruuna and @jamesturner246
I took a look and there are a few residual errors thrown by mypy, these are

mypy .
utils.py:89: error: "Message" has no attribute "value"  [attr-defined]
utils.py:91: error: "Message" has no attribute "value"  [attr-defined]
utils.py:93: error: "Message" has no attribute "value"  [attr-defined]
utils.py:95: error: "Message" has no attribute "value"  [attr-defined]
core.py:129: error: No overload variant of "update" of "MutableMapping" matches argument type "object"  [call-overload]
core.py:129: note: Possible overload variants:
core.py:129: note:     def update(self, SupportsKeysAndGetItem[str, object], /) -> None
core.py:129: note:     def update(self, SupportsKeysAndGetItem[str, object], /, **kwargs: object) -> None
core.py:129: note:     def update(self, Iterable[tuple[str, object]], /) -> None
core.py:129: note:     def update(self, Iterable[tuple[str, object]], /, **kwargs: object) -> None
core.py:129: note:     def update(self, **kwargs: object) -> None
actions/file_run_registry.py:4: error: Skipping analyzing "daqconf.consolidate": module is installed, but missing library stubs or py.typed marker  [import-untyped]
actions/db_run_registry.py:6: error: Skipping analyzing "daqconf.consolidate": module is installed, but missing library stubs or py.typed marker  [import-untyped]
actions/db_run_registry.py:6: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
actions/db_run_registry.py:7: error: Skipping analyzing "daqconf.jsonify": module is installed, but missing library stubs or py.typed marker  [import-untyped]
actions/db_run_registry.py:8: error: Skipping analyzing "daqconf.validate": module is installed, but missing library stubs or py.typed marker  [import-untyped]
actions/thread_pinning.py:4: error: Skipping analyzing "conffwk": module is installed, but missing library stubs or py.typed marker  [import-untyped]
actions/thread_pinning.py:4: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
configuration.py:5: error: Skipping analyzing "conffwk": module is installed, but missing library stubs or py.typed marker  [import-untyped]
configuration.py:19: error: Type of variable becomes "Any" due to an unfollowed import  [no-any-unimported]
configuration.py:21: error: Argument 4 to "_fill_pre_post_transition_sequence_oks" becomes "list[Any] | None" due to an unfollowed import  [no-any-unimported]
configuration.py:93: error: "object" has no attribute "states"  [attr-defined]
configuration.py:94: error: "object" has no attribute "initial_state"  [attr-defined]
configuration.py:98: error: "object" has no attribute "actions"  [attr-defined]
configuration.py:103: error: "object" has no attribute "transitions"  [attr-defined]
configuration.py:114: error: "object" has no attribute "pre_transitions"  [attr-defined]
configuration.py:119: error: "object" has no attribute "post_transitions"  [attr-defined]
configuration.py:136: error: "object" has no attribute "command_sequences"  [attr-defined]
Found 20 errors in 6 files (checked 21 source files)

I can take a look at the daqconf work if wanted, other than that I think this is close to complete.
Note - this used a local copy of John's PR for generating stubs for conffwk.

jamesturner246 · 2026-07-16T19:31:26Z

Thanks @PawelPlesniak. I hate to say it, but in this case the effort of merging versus quickly redoing the same changes in a fresh branch may be better in the latter. Sorry for the noise @miruuna

I'm away on leave from tomorrow until the 27th. FYI

miruuna added 3 commits June 4, 2026 09:02

Make mypy compliant - no actions subdir yet

e64c26e

Move protocols to separate file

c8a08a7

Fix circular import error

26c6606

miruuna linked an issue Jun 9, 2026 that may be closed by this pull request

[Feature]: mypy - fsm #846

Open

miruuna marked this pull request as draft June 9, 2026 19:19

Add stubs and fix circular import

efe2ad8

miruuna marked this pull request as ready for review June 10, 2026 08:25

miruuna marked this pull request as draft June 10, 2026 08:45

miruuna added 2 commits June 16, 2026 18:47

add pybind11-stubgen for conffwk stubs

ab76d90

fix ruff typings

58b586d

miruuna marked this pull request as ready for review June 18, 2026 11:51

miruuna requested a review from jamesturner246 June 18, 2026 11:51

PawelPlesniak self-requested a review July 9, 2026 12:42

jamesturner246 and others added 12 commits July 13, 2026 17:22

Phased merge 1.

bd3ae9f

Phased merge 2.

15bc3f8

Phased merge 3.

032b67b

Phased merge 4.

cf5d919

Phased merge 5.

87f319e

Phased merge 6

1b9925e

Phased merge 7

cf71734

Phased merge 8

119bd60

Phased merge 9

cedbf88

Phased merge 10

a494013

Merge branch 'develop' into miruuna/846-feature-mypy-fsm

016d724

Merge complete

1b7f9fa

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

mypy - FSM#940

mypy - FSM#940
miruuna wants to merge 18 commits into
developfrom
miruuna/846-feature-mypy-fsm

miruuna commented Jun 9, 2026 •

edited

Loading

Uh oh!

miruuna commented Jun 18, 2026

Uh oh!

jamesturner246 commented Jun 30, 2026 •

edited

Loading

Uh oh!

PawelPlesniak commented Jul 8, 2026

Uh oh!

PawelPlesniak commented Jul 16, 2026

Uh oh!

jamesturner246 commented Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

miruuna commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

List of required branches from other repositories

Change log

Suggested manual testing checklist

Prior to marking this as "Ready for Review"

Final checklist prior to marking this as "Ready for Review"

Reviewer checklist

Prior to merging

Notification message for a Slack channel

For an single merge that changes the user workflow

For co-ordinated merge

Uh oh!

miruuna commented Jun 18, 2026

Uh oh!

jamesturner246 commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PawelPlesniak commented Jul 8, 2026

Uh oh!

PawelPlesniak commented Jul 16, 2026

Uh oh!

jamesturner246 commented Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miruuna commented Jun 9, 2026 •

edited

Loading

jamesturner246 commented Jun 30, 2026 •

edited

Loading